home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
BBS Toolkit
/
BBS Toolkit.iso
/
doors_1
/
ktfm_200.zip
/
KTFLEA.DOC
< prev
next >
Wrap
Text File
|
1992-12-08
|
21KB
|
493 lines
KT-FleaMarket v2.00
Copyright(c) 1992 by Kelsey Technologies
All Rights Reserved.
---------------------------------
Kelsey Technologies
P.O. Box 288
St. Mary's, GA 31558
Phone: (912) 882-0533
BBS: (912) 882-3588
DESCRIPTION
-----------
KT-FleaMarket is a BBS Door program which will provide your users
with a complete, full featured Advertisement System. KT-FleaMarket
will support unlimited categories, up to 1 billion Ads, COM1-4,
non-standard IRQ's, DOOR.SYS, DORINFOx.DEF and High Speed Modems.
KT-FleaMarket now supports 'Attached Files'. Your users can leave
an ad and then upload an attached file using Zmodem, Ymodem,
Ymodem-G, Xmodem, and Xmodem-1k (without the need for DSZ). Others
can download the attached file while viewing the ad using the same
protocols. Whether you allow Attached Files or Not is up to you.
The Validation Option allows you to automatically set all NEW ads to
'invalidated'. After the New ad is left, the only person who may
view this ad is the SysOp. The Validation Option can serve two
purposes. One: you could 'sell' ad space on your system, or Two:
you'll be able to view each ad before it's released to prevent
unethical, immoral, nasty language, etc. If you 'turn off' the
validation option, all ads are immediately released for public
viewing.
KT-FleaMarket v2.0 uses Real-Time File and Record Locking to provide
the safest multi-user environment available which can theoretically
support an unlimited number of concurrent users.
FILES:
------
This is a VERY BASIC description of each file. Files requiring
more explicit information will be addressed later on in the
document.
You should have the following files:
README 1ST <-- Instructions on UPGRADING to version 2.0
KTFLEA DOC <-- The file you are reading now.
KTFLEA EXE <-- The KT-FleaMarket Executable File.
KTFLEA CAT <-- A sample Category file.
KTFLEA KEY <-- Registration Key File.
USERHELP TXT <-- Help file for the KT-FleaMarket System.
You are welcome to Modify this file as
needed. Also, you may want to place this
file in an archived form for your users to
download.
KTFLEA DBF <-- KT-FleaMarket Main Database File.
KTFLEA NTX <-- KT-FleaMarket Main Index File.
LOCAL BAT <-- Batch file for running KT-FleaMarket in
LOCAL Mode.
PURGE BAT <-- Batch file for Purging Old Records from
the Database.
PACK BAT <-- Batch file for Removing Deleted Records
from the Database.
SETUP BAT <-- Batch file for Setting-Up KT-FleaMarket.
MAKETEXT BAT <-- Batch file for making the KTFM_ADS.TXT
file.
SAMPLBAT DOC <-- Sample Batch Files
KTFM200 DBF <-- Used by the UPGRADE utility for Upgrading
to v2.0 from a previous version of
KT-FleaMarket.
These files may be created while using KT-FleaMarket:
KTFLEA CFG <-- Configuration file containing the Attached
Files Directory
KTFM_ADS TXT <-- Text file of ALL the Validated Ads in your
database. This file should be archived for
downloading from within the door.
UPGRADING FROM A PREVIOUS VERSION
---------------------------------
If you're currently using KT-FleaMarket prior to v2.0 you'll need
to upgrade your Database Files to be compatable with the new
version.
PLEASE PRINT THE README.1ST FILE FOR DETAILED INSTRUCTIONS
BEFORE PERFORMING THE UPGRADE!
LOCAL TESTING
-------------
When I download a new DOOR, the first thing I want to do is try it
out. Unfortunately, a lot of DOORS out there require extensive
setup and configuration to run locally. Not mine!
Type: KTFLEA LOCAL
This will start KT-FleaMarket in LOCAL mode and allow you to add,
edit, delete, etc. and test out the system. I've included a batch file
called LOCAL.bat for your convenience.
NOTE: To fully enjoy the system, you should read the docs. There
are many features which you'll not notice in local mode. There are
a few features that you can only use in Local Mode...Please Read On
When You're Done Playing....have fun!
SETUP:
------
You should first decide on three items:
What Categories will you offer your users?
You can have an unlimited number of Categories but the
ones I've provided in the KTFLEA.CAT file are probably
the most you'll need. I'm not saying however that you
should use only mine....please be creative! Let me know
some of the unique Categories you've come up with.
Will you permit files to be attached to the Ads?
This is pretty self explanatory. Either you'll allow it
or not.
Will you require Validation of New Ads?
If you'll want all New Ads to be Validated before
release to the public, then the answer here would be
Yes. KT-FleaMarket allows you to run the system as
either Open (meaning new ads are automatically released)
or Closed (meaning new ads are not released until YOU
validate them).
CATEGORIES:
-----------
In the file KTFLEA.CAT you'll find some examples of Categories
Similar to those you'd find in the local newspaper (and a few of my
own).
╔════════════════════════════════════════════════════════════╗
║ NOTES: THE FIRST LINE MUST ALWAYS BE: ALL CATEGORIES;ALL ║
║ ║
║ DON'T PUT ANY OTHER TEXT OR NOTES IN THE CATEGORY ║
║ FILE EXCEPT YOUR CATEGORIES. ║
╚════════════════════════════════════════════════════════════╝
The structure of this file goes like this:
Category Description;CATEGORY NAME
The Category Description may be up to 65 characters and the
CATEGORY NAME may be up to 20 characters with a semi-colon (;) as a
separator (can you say that three times real fast?).
Local BBS Ads;LOCAL BBS ADS
Garage Sales;GARAGE SALE
Dog, Cat, Bird, and Mouse Grooming;PET GROOMING
Get the idea? The CATEGORY NAME must be in all CAPS. Don't put any
spaces between the Description, the Semi-Colon, and the Name.
ADDING/DELETING CATEGORIES:
----------------------------
Feel free to use your favorite editor to sort this listing of
Categories. Makes for a better presentation to the user.
If you wish to REMOVE a Category from the list, ensure you've
deleted all Ads under that Category from the Database First (or
use the KTFMEditor which is described below).
If you want to ADD a Category, you don't need to do a thing
except put it in the KTFLEA.CAT file. KT-FleaMarket will take
care of everything else.
ATTACHED FILES:
---------------
If you'll be permitting Attached Files, you first must create a
directory to hold these files. For instance, let's say your
KT-FleaMarket system will be in the directory C:\BBS\DOORS\KTFLEA.
You should create another directory under this one to hold the
Attached Files. C:\BBS\DOORS\KTFLEA\FILES\
After you create the Attached Files Directory, run the SETUP
utility by issuing the command:
KTFLEA SETUP
You'll be prompted to enter the directory which will contain the
Attached Files. If you leave this field blank and enter nothing,
the Attached Files Option will be disabled. If, on the other hand,
you enter a directory, the Attached Files Option will be enabled.
VALIDATION OPTION:
------------------
The Validation Option is controlled throughout the command line as
most options are with my software (I feel it's easier than running
a setup or configure program each time you want to make a change).
More on the Validation Option in a minute.
SYNTAX ('The Batch File')
-------------------------
Basic Command Line:
KTFLEA <bbstype> <userfile> </irq#> <CTSRTS> <VALIDATE>
<bbstype> Is the BBS Software you are using. This command goes
hand-in-hand with the <userfile> command.
If your BBS can create a DOOR.SYS file, the command would be:
KTFLEA WILDCAT C:\BBS\NODE1\DOOR.SYS
If your BBS can create a DORINFOx.DEF file, the command would
be:
KTFLEA RBBS C:\BBS\NODE1\DORINFOx.DEF
You MUST specify which directory the <userfile> is in!
╒═════════════════════════════════════════════════════════════════╕
│BECAUSE YOU USE THE WILDCAT OR RBBS COMMAND DOESN'T MEAN YOU MUST│
│BE USING WILDCAT OR RBBS. THIS IS ONLY A SWITCH TO TELL │
│KT-FleaMarket HOW TO READ THE USER FILE. │
╘═════════════════════════════════════════════════════════════════╛
</irq#> (NON STANDARD IRQ's)
----------------------------
If your COM port is set up to use a Non-Standard IRQ, you may place
the IRQ number preceded by a '/' as the third argument in the
command line. You'll probably only need this feature if you're
using more than two COM ports. For example, if your COM3 were set
to use IRQ 2 instead of the standard 3, you would place '/2' as the
third argument (i.e. KTUSBBS WILDCAT C:\BBS\NODE3\DOOR.SYS /2).
<CTSRTS> (HIGH SPEED MODEMS)
----------------------------
If you're using a High Speed Modem (i.e. 9600 baud or higher),
you'll want to enable CTS/RTS Flow Control. To do this, add the
command CTSRTS. For example:
(standard IRQ)
KTUSBBS WILDCAT C:\BBS\NODE3\DOOR.SYS CTSRTS
or
(non-standard IRQ)
KTUSBBS WILDCAT C:\BBS\NODE3\DOOR.SYS /2 CTSRTS
Just remember to put 'CTSRTS' after the <userfile> argument or the
<irq#> argument.
<VALIDATE> (VALIDATION OPTION)
------------------------------
If you wish to enable the Validation Option, add the command
VALIDATE. For example:
(standard IRQ, no CTSRTS disabled)
KTUSBBS WILDCAT C:\BBS\NODE3\DOOR.SYS VALIDATE
or
(non-standard IRQ, no CTSRTS disabled)
KTFLEA WILDCAT C:\BBS\NODE3\DOOR.SYS /2 VALIDATE
or
(non-standard IRQ, CTSRTS enabled)
KTFLEA WILDCAT C:\BBS\NODE3\DOOR.SYS /2 CTSRTS VALIDATE
Just remember to put 'VALIDATE' as the LAST command.
SAMPLE BBS BATCH FILES
---------------------
See the file SAMPLBAT.DOC for additional samples.
USERHELP.TXT
------------
The file USERHELP.TXT may be edited as you wish. This file provides
help to the user while using the DOOR. You may also wish to place this
file in a download area so your users can read up on how the system
works.
KT-FleaMarket was designed with the most Novice Users in mind. They
shouldn't need much help.
MAINTENANCE (LOCAL MODE)
------------------------
There really isn't much maintenance involved with this system. It
pretty much takes care of itself. However (always a however), if
you've enabled VALIDATION, you'll need to Validate the Un-Validated
Ads (does that make any sense? I didn't think so).
TO VALIDATE ADS:
----------------
A few quick notes about Validating Ads and Local Mode...
While viewing Ads in the Detail Mode, there are several
options available (as seen on the last line in the display).
One of these Options is (V)alidate, but it's hidden. This
(V)alidate Option 'Toggles' the Validation Status of that
particular Ad. You can tell whether the Ad is Validated or
Not by the words "Validated" or "!! NOT VALIDATED !!", which
appear right under the Category Name. This "Validation
Status" is only visible while in Local Mode.
To Validate Ads, start KT-FleaMarket in the local mode (KTFLEA
LOCAL) and Select ALL CATEGORIES.
When the Main Menu appears, you'll notice an additional option
in Blue called [V]alidate Ads (this only appears in Local Mode).
Selecting the Option [V]alidate Ads will filter out ALL Ads
which are marked as !!! NOT VALIDATED !!!.
At this point, you would select the Option, [L]ist Ads (Detail),
and step through each "Un-Validated" Ad, changing the
"Validation Status" as you see fit.
This probably sounds confusing but it's really quite easy as
you'll see when you try it.
privileges...
-------------
Being SysOp has it's privileges. While using KT-FleaMarket in
Local Mode, the options (E)dit and (K)ill will
always be available in the Detail Screens. While running as a
DOOR, these options will ONLY be available to the user who
placed it. That way, Joe can't mess with Bob's Ads. Who is Joe
and Bob?
The hidden option (V)alidate will be available at all times
while in Local Mode also.
Please see KTFMEditor later in this document.
Automatic Purge
---------------
After time, Ads become obsolete. Either the person moved, the item
sold, or a hurricane destroyed it. Regardless, the users will be
lazy and probably won't delete their old Ads. Not to fear! You can
put out in a bulletin or in the USERHELP.TXT file that all ads over
120 days will be removed. Now, make a monthly event (or weekly, or
daily, or hourly if you want) to purge Ads over 120 days. Oh yea,
you need the command.....
KTFLEA PURGE 120
Simply replace the 120 above with what ever number of days old you
wish to remove. NOTE: If anyone is using the system on another
node, the Purge Command will wait up to 10 Seconds to get an
Exclusive Lock on the Database. If Exclusive Control can't be had,
the purge will not take place. Just a little safety feature.
Removing Deleted Ads:
---------------------
Well, OK, some of your users may actually delete their ads when they
no longer apply. If this is the case, run the PACK command on a
regular basis to remove these deleted records. The command is:
KTFLEA PACK
This command is useful if you don't have a need to ever Purge the
Database. They both do the same thing, as far as removing Deleted
Records. If you use the Purge Command, the Pack Command is
unnecessary. NOTE: If anyone is using the system on another node,
the Pack Command will wait up to 10 Seconds to get an Exclusive
Lock on the Database. If Exclusive Control can't be had, the Pack
will not take place. Just another little safety feature.
Making the Classified Ads File:
-------------------------------
An option within KT-FleaMarket is [D]ownload Ads List. That's
great, but if there isn't one....well, nothing is going to happen.
To create the Classified Ads File, issue the command:
KTFLEA MAKETEXT
This will create a file called KTFM_ADS.TXT which contains all the
Validated Ads in the Database, sorted on Category. You'll need to
archive this file and call it KTFM_ADS.ZIP/LZH/ARJ
KT-FleaMarket will first look in the Attached Files Directory (if you've
enabled that feature), then in the current directory for a file
called KTFM_ADS which ends in either .ZIP, .LZH, or .ARJ. In that
order. I've included a batch file called MAKETEXT.BAT for your
convenience (Using PKZIP).
KTFMEditor
----------
If you'd like more control over the editing of the Database, call
our BBS and download KTFMED10.ZIP. This is a full featured Database
Editor for use with KT-FleaMarket v2.0. It makes the archive too
big to simply throw it in with the KT-FleaMarket System...sorry...
WHAT THE USER NEEDS
-------------------
At this time, KT-FleaMarket only supports ANSI users. We have plans
to support "non-ANSI" users in the future..but..this day in age, most
users have the ability to support ANSI and this shouldn't be too
much of a problem for you. Please leave us comments on this subject.
WHAT THE USER CAN DO
--------------------
Please look at the USERHELP.TXT file for option information.
TECHNICAL STUFF
---------------
* You must, at a minimum, have the files and buffers set at:
FILES = 40
BUFFERS = 30
* KT-FleaMarket v2.0's EXE Load Image Size is 295k.
* KT-FleaMarket uses interal Dynamic Overlays- please don't try to
compress the EXE file with PKLite or LZE or any other EXE
Compression Program, it won't work.
* KT-FleaMarket has a built-in VMM (Virtual Memory Manager). The
system will use all available extended memory up to 8 Meg. If none
is available, it will resort to Disk Swapping in the current
directory.
* KT-FleaMarket was developed in Clipper v5.01a.
CREDITS
-------
Thanks to Tammy, Kelsey, and Lindsey for their support over
the past six years.
Some names may be used in this manual which are trademarks or
registered trademarks of their respective owners.
REGISTRATION
------------
KT-FleaMarket is not public domain, but Shareware. You are granted
a limited license to operate this program for a test period of 30
days. Completing this test period, if you decide to continue its
use, you must register. The registration fee is $27.00. Georgia
residents add 6% sales tax.
For more information on how to register, please print out the file
REGISTER.FRM.
╔══════════════════════════════════════════════════════════════════╗
║ !!! KT-FleaMarket IS NOT CRIPPLED !!! ║
║ ║
║By registering KT-FleaMarket you will encourage myself and other ║
║shareware authors to continue to provide you with quality software║
║at the most reasonable prices. After registration, your BBS name ║
║will appear on the opening and closing screens and remove that ║
║annoying delay and big bold message telling everyone that you ║
║haven't registered the software (whew, what a mouthful..) . Other ║
║than that, you have in your hands a fully functional KT-FleaMarket║
║system. I DON'T BELIEVE IN CRIPPLEWARE, HELP ME KEEP IT THAT WAY! ║
╚══════════════════════════════════════════════════════════════════╝
COMMENTS PLEASE!
----------------
Please place the UNREGISTERED VERSION of this program in your
communications program download area for others to evaluate. Your
comments on this program are most appreciated (and encouraged).
Please call our BBS and leave comments, the number is (912) 882-3588
1200-14400 / 24 hrs. Your comments could very well be what everyone
else wants also, please don't be shy!
What does the future hold? You tell me!
DISCLAIMER/PROBLEMS/WARRANTY
----------------------------
This program is distributed as is. We guarantee that this program
and its associated files will do nothing more than take up disk
space on your computer!
There is NO warranty!
Should something go wrong, a file will be created in the
KT-FleaMarket directory called ERROR.LOG. This will be very helpful
to us to determine what went wrong, should you have any problems.
Please communicate any problems with us through the Kelsey
Technologies Support BBS at (912) 882-3588. Any problems received
will be treated as high priority.